Miscellaneous

MSLUMessage

• Syntax:

  double MSLUMessage(unsigned long Type, const wchar_t* Message);
  

  Type: Message type (0 = Information; 1 = Warning; 2 = Error).
  Message: Text message.

• Description:

  Issue message.

• Returns:

  Always returns 0.

MSLUTerminate

• Syntax:

  double MSLUTerminate(const wchar_t* Message);
  

  Message: Text message.

• Description:

  Terminate model execution and issue message.

• Returns:

  Always returns 0.

MSLUAssert

• Syntax:

  double MSLUAssert(double Condition, const wchar_t* Message);
  

  Condition: Boolean value.
  Message: Message to be issued in case "Condition" is false.

• Description:

  Asserts whether condition is fulfilled. In case it is not, a message is issued and model execution is terminated.

• Returns:

  Always returns 0.

MSLUGetStartTime

• Syntax:

  double MSLUGetStartTime(void);
  

• Description:

  Get start time of simulation.

• Returns:

  Start time.

MSLUGetStopTime

• Syntax:

  double MSLUGetStopTime(void);
  

• Description:

  Get stop time of simulation.

• Returns:

  Stop time.

MSLUSetGlobalValue

• Syntax:

  double MSLUSetGlobalValue(const char* GlobalName, double Value);
  

  GlobalName: Name of global value container.
  Value: Value to be stored.

• Description:

  Store scalar value into named global storage.

• Returns:

  Always returns 0.

MSLUGetGlobalValue

• Syntax:

  double MSLUGetGlobalValue(const char* GlobalName);
  

  GlobalName: Name of global value container.
  

• Description:

  Retrieve scalar from named global storage.

• Returns:

  Value.

MSLUSetGlobalVector

• Syntax:

  double MSLUSetGlobalVector(const char* GlobalName, double* pValues, unsigned long NoValues);
  

  GlobalName: Name of global value container.
  Values: Values to be stored.
  NoValues: Number of values.

• Description:

  Store vector into named global storage. A pointer to the first element of the vector, and the number of vector elements have to be passed as arguments.

• Returns:

  Always returns 0.

MSLUGetGlobalVector

• Syntax:

  double MSLUGetGlobalVector(const char* GlobalName, double* pValues, unsigned long NoValues);
  

  GlobalName: Name of global value container.
  Values: Values that have been retrieved.
  NoValues: Number of values.

• Description:

  Retrieve vector from named global storage. A pointer to the first element of the vector, and the number of vector elements have to be passed as arguments.

• Returns:

  Always returns 0.

MSLUGetPath

• Syntax:

  char* MSLUGetPath(void);
  

• Description:

  Get file path of the executable model.

• Returns:

  File path of the executable model.

MSLUGetPlusInf

• Syntax:

  double MSLUGetPlusInf(void);
  

• Description:

  Get largest positive double value that can be represented.

• Returns:

  Largest positive double value.

MSLUGetMinInf

• Syntax:

  double MSLUGetMinInf(void);
  

• Description:

  Get smallest negative double value that can be represented.

• Returns:

  Smallest negative double value.

MSLUGetMax2

• Syntax:

  double MSLUGetMax2(double Value1, double Value2);
  

  Value1: First value.
  Value2: Second value

• Description:

  Get maximum of 2 values.

• Returns:

  Maximum of 2 values.

MSLUGetMin2

• Syntax:

  double MSLUGetMin2(double Value1, double Value2);
  

  Value1: First value.
  Value2: Second value

• Description:

  Get minimum of 2 values.

• Returns:

  Minimum of 2 values.

MSLUGetSign

• Syntax:

  double MSLUGetSign(double Value);
  

  Value: Argument for sign operation.
  

• Description:

  Get sign of value.

• Returns:

  -1 in case value is strict negative; +1 in case value is strict positive; 0 otherwise.

MSLUGetDiv

• Syntax:

  double MSLUGetDiv(double Value1, double Value2);
  

  Value1: Nominator.
  Value2: Denominator.

• Description:

  Get result of integer division.

• Returns:

  Result of integer division.

MSLUGetMod

• Syntax:

  double MSLUGetMod(double Value1, double Value2);
  

  Value1: Nominator.
  Value2: Denominator.

• Description:

  Get remainder of integer division.

• Returns:

  Remainder of integer division.

MSLUGetRem

• Syntax:

  double MSLUGetRem(double Value1, double Value2);
  

  Value1: Nominator.
  Value2: Denominator.

• Description:

  Get remainder of integer division.

• Returns:

  Remainder of integer division.

MSLUGetSystemTime

• Syntax:

  double MSLUGetSystemTime(void);
  

• Description:

  Get system time.

• Returns:

  System time.

MSLUSetSeed

• Syntax:

  double MSLUSetSeed(double Seed);
  

  Seed: Seed for RNG.

• Description:

  Set seed for the C run-time library's RNG.

• Returns:

  Always returns 0.

MSLUGetRandom

• Syntax:

  double MSLUGetRandom(void);
  

• Description:

  Get uniformely distributed random value from the C run-time library's RNG.

• Returns:

  Random value between 0 and 1.

MSLUGetFac

• Syntax:

  double MSLUGetFac(double Value);
  

  Value: Argument for factorial computation.

• Description:

  Compute factorial of "Value".

• Returns:

  Factorial of "Value".

MSLUGetChebyshev

• Syntax:

  double MSLUGetChebyshev(double Index, double Value);
  

  Index: index of the function. Value: Argument for Chebyshev computation.

• Description:

  Compute the Chebyshev value.

• Returns:

  Chebyshev value.

MSLUGetMax

• Syntax:

  double MSLUGetMax(double* Values, double NoValues);
  

  Values: Vector of values.
  NoValues: Number of values in vector.

• Description:

  Get maximum of vector of values.

• Returns:

  Maximum of vector of values.

MSLUGetMin

• Syntax:

  double MSLUGetMin(double* Values, double NoValues);
  

  Values: Vector of values.
  NoValues: Number of values in vector.

• Description:

  Get minimum of vector of values.

• Returns:

  Minimum of vector of values.

MSLUGetInterpolated

• Syntax:

  double MSLUGetInterpolated(double* ValuesX, double* ValuesY, double NoValues, double Value);
  

  ValuesX: Vector of X-values.
  ValuesY: Vector of Y-values.
  NoValues: Number of values in vector.
  Value: X-value for which to perform interpolation.

• Description:

  Perform linear interpolation into vector of values.

• Returns:

  Interpolated Y-value.

MSLUGetLagrange

• Syntax:

  double MSLUGetLagrange(double* ValuesX, double* ValuesY, double NoValues, double Value);
  

  ValuesX: Vector of X-values.
  ValuesY: Vector of Y-values.
  NoValues: Number of values in vector.
  Value: X-value for which to perform interpolation.

• Description:

  Perform Lagrange interpolation into vector of values.

• Returns:

  Interpolated Y-value.

MSLUGetInterpValue

• Syntax:

  double MSLUGetInterpValue(double* Values, double NoValues, double Value);
  

  Values: Vector of values.
  NoValues: Number of values in vector.
  Value: X-value for which to perform interpolation.

• Description:

  Perform linear interpolation into vector of values. The vector is to be composed of "NoValues" X-values, followed by "NoValues" Y-values (so 2 * "NoValues" values in total).

• Returns:

  Interpolated Y-value.

MSLUFindThreshold

• Syntax:

  double MSLUFindThreshold(double* Values, double NoValues, double Threshold);
  

  Values: Vector of values.
  NoValues: Number of values in vector.
  Threshold: Threshold value.

• Description:

  Get index of first value in vector which is larger than threshold.

• Returns:

  Index of first value that is larger than threshold.

MSLUFindThresholdFromEnd

• Syntax:

  double MSLUFindThresholdFromEnd(double* Values, double NoValues, double Threshold);
  

  Values: Vector of values.
  NoValues: Number of values in vector.
  Threshold: Threshold value.

• Description:

  Get index of first value in which is larger than threshold, starting from the end of the vector.

• Returns:

  Index of first value that is larger than threshold.

MSLUFindSum

• Syntax:

  double MSLUFindSum(double* Additions, double* Values, double NoValues, double Threshold);
  

  Additions: Values to be used in sum computation.
  Values: Vector of values.
  NoValues: Number of values in vector.
  Threshold: Threshold value.

• Description:

  For all values at the end of "Values" that are not smaller than "Threshold", make the sum of the corresponding values of the "Additions" array.

• Returns:

  Sum of values.

MSLUCalcOffset

• Syntax:

  unsigned long MSLUCalcOffset(double Size1, double Index1, double Size2, double Index2, double Size3, double Index3)
  

  Size1: Size of first dimension.
  Index1: Index of first dimension.
  Size2: Size of second dimension.
  Index2: Index of second dimension.
  Size3: Size of third dimension.
  Index3: Index of third dimenstion.

• Description:

  Compute the position in a flat vector of values (according to the row-major principle and starting at index 0) that corresponds with an element out of a matrix of either 1, 2 or 3 dimensions (starting at index 1).

  The following situations can occur:

  • 1-dim (Size1 != 0; Size2 = 0; Size3 = 0):

    Flat vector index = Index1 - 1

  • 2-dim (Size1 != 0; Size2 != 0; Size3 = 0):

    Flat vector index = (Index1 - 1) + (Index2 - 1) * Size1

  • 3-dim (Size1 != 0; Size2 != 0; Size3 != 0):

    Flat vector index = (Index1 - 1) + (Index2 - 1) * Size1 + (Index3 - 1) * Size2 * Size1

• Returns:

  Flat vector index.

MSLUSetValue1

• Syntax:

  unsigned long MSLUSetValue1(double* Values, double Value, double Size1, double Index1)
  

  Values: Vector of values.
  Value: Value to set.
  Size1: Size of first dimension.
  Index1: Index of first dimension.

• Description:

  Set a value in a 1-dim vector.

• Returns:

  Always returns 0.

MSLUSetValue2

• Syntax:

  unsigned long MSLUSetValue2(double* Values, double Value, double Size1, double Size2, double Index1, double Index2)
  

  Values: Vector of values.
  Value: Value to set.
  Size1: Size of first dimension.
  Size2: Size of second dimension.
  Index1: Index of first dimension.
  Index2: Index of second dimension.

• Description:

  Set a value in a 2-dim vector.

• Returns:

  Always returns 0.

MSLUSetValue3

• Syntax:

  unsigned long MSLUSetValue3(double* Values, double Value, double Size1, double Size2, double Size3, double Index1, double Index2, double Index3)
  

  Values: Vector of values.
  Value: Value to set.
  Size1: Size of first dimension.
  Size2: Size of second dimension.
  Size3: Size of third dimension.
  Index1: Index of first dimension.
  Index2: Index of second dimension.
  Index3: Index of third dimension.

• Description:

  Set a value in a 3-dim vector.

• Returns:

  Always returns 0.

MSLUGetValue1

• Syntax:

  double MSLUGetValue1(double* Values, double Size1, double Index1)
  

  pValues: Vector of values.
  Size1: Size of first dimension.
  Index1: Index of first dimension.

• Description:

  Get a value from a 1-dim vector.

• Returns:

  Value.

MSLUGetValue2

• Syntax:

  double MSLUGetValue2(double* Values, double Size1, double Size2, double Index1, double Index2)
  

  pValues: Vector of values.
  Size1: Size of first dimension.
  Size2: Size of second dimension.
  Index1: Index of first dimension.
  Index2: Index of second dimension.

• Description:

  Gett a value from a 2-dim vector.

• Returns:

  Always returns 0.

MSLUGetValue3

• Syntax:

  double MSLUGetValue3(double* Values, double Size1, double Size2, double Size3, double Index1, double Index2, double Index3)
  

  pValues: Vector of values.
  Size1: Size of first dimension.
  Size2: Size of second dimension.
  Size3: Size of third dimension.
  Index1: Index of first dimension.
  Index2: Index of second dimension.
  Index3: Index of third dimension.

• Description:

  Get a value from a 3-dim vector.

• Returns:

  Value.

MSLUSleep

• Syntax:

  double Sleep(double Milliseconds)
  

  Milliseconds: Number of milliseconds to put the thread to sleep.

• Description:

  Puts the executation model to sleep for a specified number of milliseconds (real-time).

• Returns:

  0.

MSLUExec

• Syntax:

  double Exec(const char* Program, const char* Args, const char* Path)
  

  Program: Program to execute.
  Args: Program arguments.
  Path: Path.

• Description:

  Executes a program with the arguments and the path specified.

• Returns:

  Exit code of program execution.

MSLUExecBatch

• Syntax:

  double ExecBatch(double FileID, double Arg01, double Arg02, double Arg03, double Arg04, double Arg05, double Arg06, double Arg07, double Arg08, double Arg09, double Arg10)
  

  FileID: Batch file ID.
  Arg01: Argument 1.
  Arg02: Argument 2.
  Arg03: Argument 3.
  Arg04: Argument 4.
  Arg05: Argument 5.
  Arg06: Argument 6.
  Arg07: Argument 7.
  Arg08: Argument 8.
  Arg09: Argument 9.
  Arg10: Argument 10.

• Description:

  Executes a batch file named "BatchFile.<FileID>.bat" with a maximum of 10 arguments in the project folder.

• Returns:

  Exit code of batch file execution.

MSLUTimerCreate

• Syntax:

  double TimerCreate(void)
  

• Description:

  Creates a timer for real-time elapsed time measurement.

• Returns:

  Unique identifier referring to the newly created timer.

MSLUTimerRemove

• Syntax:

  double TimerRemove(double ID)
  

  ID: Timer identifier.

• Description:

  Remove timer.

• Returns:

  Always returns 0.

MSLUTimerRemoveAll

• Syntax:

  double TimerRemoveAll(void)
  

• Description:

  Remove all timers.

• Returns:

  Always returns 0.

MSLUTimerReset

• Syntax:

  double TimerReset(double ID)
  

  ID: Timer identifier.

• Description:

  Reset timer.

• Returns:

  Always returns 0.

MSLUTimerGetElapsedTime

• Syntax:

  double TimerGetElapsedTime(double ID)
  

  ID: Timer identifier.

• Description:

  Get elapsed time in seconds.

• Returns:

  Always returns 0.

MSLUTauCircularPipe

• Syntax:

  double MSLUTauCircularPipe(double Arel, double prevTau, double BreakupCriterion)
  

  Arel: relative area of the pipe.
  prevTau: previous value of filling level.
  BreakupCriterion: break-up criterion.
  

• Description:

  Computes the filling level (Tau) for a circular pipe.

• Returns:

  Value.